//
// CrackArg
//
// Copyright (C) jextra.net.
//
//  This file is part of the Crack build system.
//
//  The Crack build system is free software; you can redistribute it 
//  and/or modify it under the terms of the GNU Lesser General Public
//  License as published by the Free Software Foundation; either
//  version 2.1 of the License, or (at your option) any later version.
//
//  The Crack build system is distributed in the hope that it will be 
//  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with the Crack build system; if not, write to the Free
//  Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
//  02111-1307 USA.
//

package net.jextra.crack;

import java.lang.annotation.*;

/**
 * <p>
 * This works in conjunction with {@link CrackCommand} to describe the parameters to a method
 * that can be called from the command-line.
 * </p><p>
 * These are only optional and not required for each parameter of a CrackCommand.
 * </p>
 */
@Retention( RetentionPolicy.RUNTIME )
@Target( ElementType.PARAMETER )
public @interface CrackArg
{
    public static String UNNAMED = "*UNNAMED*";

    /**
     * Command name, default is to be parameter name.
     */
    String value() default "*UNNAMED*";

    /**
     * User readable description of the command.
     */
    String description() default "";
}

